/*
 * Copyright (c) 2012, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.bmi.gwt.mi.server.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.bmi.gwt.mi.server.events.MiEventHandler;
import org.bmi.gwt.mi.shared.util.Constants;

/**
 * This elements annotates {@link MiEventHandler} object defining which target
 * object (by its id) and which method must be executed to fire an event. Note
 * that if no method is declared by default it will be the (or a) constructor.
 * 
 * @author marco.tamburelli@gmail.com
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ObjectMiHandler
{
	/**
	 * It provides the id of the target object. The annotated event handler will
	 * trigger the event only when matching such id from a method invocation
	 * request.
	 * 
	 * @return The target object id.
	 */
	String objectId();

	/**
	 * It provides to an annotated {@link MiEventHandler} the name of the target
	 * method.
	 * 
	 * @return The name of the method.
	 */
	String methodName() default Constants.CONSTRUCTOR;

	/**
	 * Provides the type of parameters for the declared method or constructor.
	 * 
	 * @return Array of parameters types.
	 */
	Class<?>[] parameterTypes();

	/**
	 * It tells on which queues the method handler will be enabled.
	 * 
	 * An array of strings should be provided, in which each string can be the
	 * name of a queue, or an expression for a pool.
	 * 
	 * @return An array containing expressions for allowed queues.
	 */
	String[] allowedQueues() default { "*" };
}
